/*
 * Copyright 2022 Scheer PAS Schweiz AG
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package io.apiman.manager.api.beans.events;

/**
 * All Apiman events should implement this class.
 *
 * <p>Contains headers segment for various metadata that is useful to the event but does not pertain to the
 * semantics of the event itself (such as version, timestamps, etc.). This is mostly aligned with CloudEvents.
 *
 * <p>Annotate your events with @{@link ApimanEvent}
 *
 * @author Marc Savy {@literal <marc@blackparrotlabs.io>}
 */
public interface IVersionedApimanEvent {

    /**
     * Get headers for this event
     */
    ApimanEventHeaders getHeaders();
}
